/*
 * Copyright (c) 2004-2008,2018 KNOPFLERFISH project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials
 *   provided with the distribution.
 *
 * - Neither the name of the KNOPFLERFISH project nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.knopflerfish.service.junit;

import java.io.PrintWriter;
import java.io.IOException;

import junit.framework.TestResult;
import junit.framework.TestSuite;

public interface JUnitService {

  /**
   * Run a specified test and dump the result as XML to the specified writer.
   *
   * @param out         writer to which XML formatted results should be
   *                    written.
   * @param suite       The test suite to run
   * @throws IOException if result cannot be written to the writer
   */
  public void runTest(PrintWriter out,
                      TestSuite suite) throws IOException;

  /**
   * Run a specified test and dump the result as XML to the specified writer.
   *
   * @param out         writer to which XML formatted results should be
   *                    written.
   * @param suite       The test suite to run
   * @throws IOException if result cannot be written to the writer
   */
  public TestResult runTestSuite(PrintWriter out,
                                 TestSuite suite) throws IOException;
  
  /**
   * Get a specified test (which is registered in the Framework).
   *
   * <p>
   * All test are wrapped into TestSuites, even if they are registered as
   * plain Tests.
   * </p>
   *
   * @param id     service.pid which Test (or TestSuite) is registered as
   * @param subid  optional subtest name of TestSuites.
   *               Can be <tt>null</tt>
   */
  public TestSuite getTestSuite(String id,
                                String subid);


}
